home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / iMusic.h < prev    next >
Text File  |  2002-01-14  |  2KB  |  93 lines
  1. //
  2. // (c) 1998-9 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // iMusic.h
  5. //
  6. // Compiler-generated export header for package "iMusic"
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /iwar2/resource/scripts/include/iMusic.h 4     11/04/01 20:10 Will $
  11. //
  12.  
  13. // Dependencies ////////////////////////////////////////////////////////////////
  14.  
  15. // Enumerated types ////////////////////////////////////////////////////////////
  16.  
  17. //
  18. // Musical suite
  19. //
  20. enum eMusicSuite
  21. {
  22.     MS_Down,
  23.     MS_Corporate,
  24.     MS_AlienThreat,
  25.  
  26.     eMusicSuiteCount
  27. };
  28.  
  29. //
  30. // Musical mood 
  31. //
  32. enum eMusicMood
  33. {
  34.     MM_Theme,
  35.     MM_Ambient,
  36.     MM_Discovery,
  37.     MM_Tension,
  38.     MM_Action,
  39.  
  40.     eMusicMoodCount
  41. };
  42.  
  43. //
  44. // Musical events
  45. //
  46. enum eMusicEvent
  47. {
  48.     ME_ShortCymbal,
  49.     ME_LongCymbal,
  50.     ME_SoftTimpani,
  51.     ME_LoudTimpani,
  52.  
  53.     eMusicEventCount
  54. };
  55.  
  56. //
  57. // Ambient environments - these provide background sounds
  58. // 
  59. enum eAmbientEnvironment
  60. {
  61.     // Normal deep space environment
  62.     AE_DeepSpace,
  63.  
  64.     // Effrit environment
  65.     AE_Effrit,
  66.  
  67.     // Aliens environment
  68.     AE_Aliens,
  69.  
  70.     eAmbientEnvironmentCount
  71. };    
  72.  
  73. // Local types ////////////////////////////////////////////////////////////////
  74.  
  75. // Forward declarations
  76. prototype iMusic.SetSuite( int suite );
  77. prototype iMusic.SetMood( int mood );
  78.  
  79. // Play a specific piece of music - if iMusic is active this may be overridden
  80. // by the context-sensitive music
  81. prototype iMusic.Play( string track, bool crossfade, bool loop );
  82.  
  83. // Play a specific event
  84. prototype iMusic.PlayEvent( int event );
  85.  
  86. // Suspend iMusic's automatic music queueing
  87. prototype iMusic.Pause();
  88.  
  89. // Resume iMusic's automatic music queueing
  90. prototype iMusic.Resume();
  91.  
  92. // Tell iMusic to add in environmental effacts
  93. prototype iMusic.SetAmbientEnvironment( eAmbientEnvironment ae );